<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class ReportUtils</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class ReportUtils</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A collection of utility methods for working with reports.</p>
		<p class="notes">
			Located in <a class="field" href="_adwords---src---Google---Api---Ads---AdWords---Util---ReportUtils.php.html">/adwords/src/Google/Api/Ads/AdWords/Util/ReportUtils.php</a> (line <span class="field">34</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
												<div class="var-title">
					static <span class="var-type">mixed</span>
					<a href="#$LOG_NAME" title="details" class="var-name">$LOG_NAME</a>
				</div>
																							</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												<div class="method-definition">
					static 						<span class="method-result">mixed</span>
										<a href="#DownloadReport" title="details" class="method-name">DownloadReport</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$reportDefinition</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">NULL</span>], <span class="var-type"><a href="../../GoogleApiAdsAdWords/Lib/AdWordsUser.html">AdWordsUser</a></span>&nbsp;<span class="var-name">$user</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">mixed</span>
										<a href="#DownloadReportWithAwql" title="details" class="method-name">DownloadReportWithAwql</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$reportQuery</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">NULL</span>], <span class="var-type"><a href="../../GoogleApiAdsAdWords/Lib/AdWordsUser.html">AdWordsUser</a></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$reportFormat</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$reportFormat:</span>)
									</div>
								
																				</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$LOG_NAME" id="$LOG_NAME"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">mixed</span>
			<span class="var-name">$LOG_NAME</span>
			 = <span class="var-default"> 'report_download'</span>			(line <span class="line-number">39</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The log name to use when logging requests.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodDownloadReport" id="DownloadReport"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method DownloadReport</span> (line <span class="line-number">85</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Downloads a new instance of an existing report definition. If the path  parameter is specified it will be downloaded to the file at that path,  otherwise it will be downloaded to memory and be returned as a string.</p>
	<ul class="tags">
				<li><span class="field">return:</span> if path isn't specified the contents of the report,      otherwise the size in bytes of the downloaded report</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">mixed</span>
		<span class="method-name">
			DownloadReport
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$reportDefinition</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">NULL</span>], <span class="var-type"><a href="../../GoogleApiAdsAdWords/Lib/AdWordsUser.html">AdWordsUser</a></span>&nbsp;<span class="var-name">$user</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$reportDefinition</span><span class="var-description">: the ReportDefinition to download or the id      of a stored report definition</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$path</span><span class="var-description">: an optional path of the file to download the report to</span>			</li>
					<li>
				<span class="var-type"><a href="../../GoogleApiAdsAdWords/Lib/AdWordsUser.html">AdWordsUser</a></span>
				<span class="var-name">$user</span><span class="var-description">: the user that created the ReportDefinition</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: the option to use when downloading the report:      {boolean} returnMoneyInMicros: if the money values in the report          should be returned in micros      {string} server: the server to make the request to. If <var>NULL</var>,          then the default server will be used      {string} version: the version to make the request against. If          <var>NULL</var>, then the default version will be used</span>			</li>
				</ul>
		
			
	</div>
<a name="methodDownloadReportWithAwql" id="DownloadReportWithAwql"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method DownloadReportWithAwql</span> (line <span class="line-number">109</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Downloads a report with AWQL. If the path parameter is specified it will be  downloaded to the file at that path, otherwise it will be downloaded to  memory and be returned as a string.</p>
	<ul class="tags">
				<li><span class="field">return:</span> if path isn't specified the contents of the report,      otherwise the size in bytes of the downloaded report</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">mixed</span>
		<span class="method-name">
			DownloadReportWithAwql
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$reportQuery</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">NULL</span>], <span class="var-type"><a href="../../GoogleApiAdsAdWords/Lib/AdWordsUser.html">AdWordsUser</a></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$reportFormat</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$reportFormat:</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$reportQuery</span><span class="var-description">: the query to use for the report</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$path</span><span class="var-description">: an optional path of the file to download the report to</span>			</li>
					<li>
				<span class="var-type"><a href="../../GoogleApiAdsAdWords/Lib/AdWordsUser.html">AdWordsUser</a></span>
				<span class="var-name">$user</span><span class="var-description">: the user to retrieve report with</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$reportFormat:</span><span class="var-description">: the report format to request</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: the option to use when downloading the report:      {string} server: the server to make the request to. If <var>NULL</var>,          then the default server will be used      {string} version: the version to make the request against. If          <var>NULL</var>, then the default version will be used</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$reportFormat</span>			</li>
				</ul>
		
			
	</div>

						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>